Package | nictiz.fhir.nl.r4.medicationprocess9 |
Type | SearchParameter |
Id | Id |
FHIR Version | R4 |
Source | https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.medicationprocess9@2.0.0-beta.6&canonical=http://nictiz.nl/fhir/SearchParameter/period-of-use |
Url | http://nictiz.nl/fhir/SearchParameter/period-of-use |
Version | 2.0.0-beta.6 |
Status | active |
Name | PeriodOfUse |
Experimental | False |
Realm | nl |
Description | Search based on the PeriodOfUse concept captured in the [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period) extension in the MedicationRequest and MedicationDispense resources, and in the `.effectivePeriod` element in the MedicationStatement resource. This SearchParameter searches the FHIR data type Period in the TimeInterval.Period extension, which is added to profiles on MedicationRequest and MedicationDispense resources, and in the `.effectivePeriod` element in the MedicationStatement resource. This SearchParameter defines a special parameter search as described by the FHIR specification: https://hl7.org/fhir/r4/search.html#special. Servers are expected to take the [ext-TimeInterval.Duration](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration) modifierExtension into account when processing a client's search. This means that either Period.start AND Period.end or Period.start AND Duration or Period.end AND Duration are used to determine the search results. After TimeInterval.Duration has been taken into account, the search parameter functions as a date parameter search: https://hl7.org/fhir/r4/search.html#date. To illustrate the expected behavior: if a Period.start and a Duration are known, but not the Period.end, the Duration should be added to the Period.start date to calculate the Period.end. The calculated Period.end date is then used to determine the search results. Next to the search results obtained by taking into account the Period and Duration as described above, it is required to also include the latest stopped MedicationRequest and MedicationDispense resources (corresponding with the MedicationAgreement, VariableDosingRegimen and AdministrationAgreement building blocks) within each pharmaceutical treatment, even if these have a period of use outside the PeriodOfUse that is being searched on. For this all MedicationRequest and MedicationDispense resources wherein the [ext-StopType](http://nictiz.nl/fhir/StructureDefinition/ext-StopType) extension is present should be considered, before including, for each pharmaceutical treatment, only the latest one based on the value of `MedicationRequest.authoredOn` and the [ext-AdministrationAgreement.AdministrationAgreementDateTime](http://nictiz.nl/fhir/StructureDefinition/ext-AdministrationAgreement.AdministrationAgreementDateTime) extension, respectively. |
Purpose | To search MedicationRequest and MedicationDispense resources on the value of the [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period) extension, and MedicationStatement resources on the value of the `.effectivePeriod` element. |
Type | special |
CapabilityStatement | |
http://nictiz.nl/fhir/CapabilityStatement/mp-MedicationData.RetrieveServe.Base ![]() | mp MedicationData.RetrieveServe.Base |
No resources found
{
"resourceType" : "SearchParameter",
"id" : "period-of-use",
"url" : "http://nictiz.nl/fhir/SearchParameter/period-of-use",
"version" : "2.0.0-beta.6",
"name" : "PeriodOfUse",
"status" : "active",
"publisher" : "Nictiz",
"contact" : [
{
"name" : "Nictiz",
"telecom" : [
{
"system" : "url",
"value" : "https://www.nictiz.nl",
"use" : "work"
}
]
}
],
"description" : "Search based on the PeriodOfUse concept captured in the [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period) extension in the MedicationRequest and MedicationDispense resources, and in the `.effectivePeriod` element in the MedicationStatement resource.\n\nThis SearchParameter searches the FHIR data type Period in the TimeInterval.Period extension, which is added to profiles on MedicationRequest and MedicationDispense resources, and in the `.effectivePeriod` element in the MedicationStatement resource. This SearchParameter defines a special parameter search as described by the FHIR specification: https://hl7.org/fhir/r4/search.html#special. Servers are expected to take the [ext-TimeInterval.Duration](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration) modifierExtension into account when processing a client's search. This means that either Period.start AND Period.end or Period.start AND Duration or Period.end AND Duration are used to determine the search results. After TimeInterval.Duration has been taken into account, the search parameter functions as a date parameter search: https://hl7.org/fhir/r4/search.html#date. To illustrate the expected behavior: if a Period.start and a Duration are known, but not the Period.end, the Duration should be added to the Period.start date to calculate the Period.end. The calculated Period.end date is then used to determine the search results.\n\nNext to the search results obtained by taking into account the Period and Duration as described above, it is required to also include the latest stopped MedicationRequest and MedicationDispense resources (corresponding with the MedicationAgreement, VariableDosingRegimen and AdministrationAgreement building blocks) within each pharmaceutical treatment, even if these have a period of use outside the PeriodOfUse that is being searched on. For this all MedicationRequest and MedicationDispense resources wherein the [ext-StopType](http://nictiz.nl/fhir/StructureDefinition/ext-StopType) extension is present should be considered, before including, for each pharmaceutical treatment, only the latest one based on the value of `MedicationRequest.authoredOn` and the [ext-AdministrationAgreement.AdministrationAgreementDateTime](http://nictiz.nl/fhir/StructureDefinition/ext-AdministrationAgreement.AdministrationAgreementDateTime) extension, respectively.",
"purpose" : "To search MedicationRequest and MedicationDispense resources on the value of the [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period) extension, and MedicationStatement resources on the value of the `.effectivePeriod` element.",
"code" : "period-of-use",
"base" : [
"MedicationRequest",
"MedicationDispense",
"MedicationStatement"
],
"type" : "special",
"comparator" : [
"eq",
"gt",
"lt",
"ge",
"le"
],
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.